schm-hr-eapi
English Version
schm-hr-eapi
Interface description: HR application system cluster
UAT_URL: https://schm-api-test.shiseido.cn/schm-hr-eapi
PROD_URL: https://schm-api.shiseido.cn/schm-hr-eapi
The application has the following functions:
- Used to interface to receive attendance data pushed by Gaiaworks.
- Provide Gaiaworks with a ready-to-call interface to get payroll data.
- Push attendance data to FSG regularly.
- Pull salary data from the FSG interface.
- Agents search successfactors' data.
Directory
This application acts as an entry agent of the HR application cluster and is responsible for receiving requests and distributing functions downwards.The whole system is dedicated to solving the management of salary, attendance, and personnel, organizational inquiries.
The whole system includes the management and inquiry of salary, attendance, personnel and organization information.
Salary data comes from fsg, attendance data from gaia, and people and organization data from successfactors.
1 Authentication Information
All request headers must contain the following key-value parameters as authentication information. You need to apply for this information from the administrator.
client_id: fa98****3452
client_secret: 108b****41f2
2 Interface list:
| Interface Request | Description |
|---|---|
| GET /api/v1/salary | Get salary data |
| POST /api/v1/attendance | Push attendance data |
| GET /api/v1/attendance | Instant get attendance data |
| POST /api/v1/salary/sync | Manually sync payroll data |
| GET /api/v1/sf/employee | Employee information query |
| GET /api/v1/sf/division | Division information query |
| GET /api/v1/sf/department | Department information query |
| GET /api/v1/sf/company | Company information query |
| GET /api/v1/sf/onboarding | onboarding information query |
3 Interface description
3.1 Get salary data
Interface Request: /api/v1/salary
Interface Description: Get payroll data from the hr interface.
Request method: GET
Request Body Description:
| Field Name | Field Description | required |
|---|---|---|
| salary_month | Salary month (yyyyMM), e.g. 202405 | Y |
| sf_code | Employee number | N |
| company | company code | N |
| deptment | deptment code | N |
| pageSize | Maximum number of returned person entries at a time. Default 500. | N |
| pageNo | Take the data on which page. begin from 0. Default 0. | N |
Request param example
https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/salary?salary_month=202309&pageSize=100&pageNo=0Response body example
[
{
"SFcode": "100003",
"name": "chuan c lin",
"company": "SCH",
"deptment": "ShouFaShi",
"salary_month": "202309",
"item": [
{
"code": "A101",
"name_cn": "基本薪资",
"name_en": "Base pay",
"amount": 2000
},
{
"code": "A103",
"name_cn": "车贴标准",
"name_en": "Car sticker standard",
"amount": 500.22
},
{
"code": "A102",
"name_cn": "基本薪资调整",
"name_en": "Base pay adjustment",
"amount": 2000
}
]
}
]3.2 Push attendance data
Interface Request: /api/v1/attendance
Interface Description: Receive the attendance data pushed by the external.
Request method: POST
Request Body Description:
| Field Name | Field Description | required |
|---|---|---|
| end_date | End date | Y |
| apply_unit | unit | Y |
| category_name | category | Y |
| create_time | create time | Y |
| category_code | category code | Y |
| begin_date | begin date | Y |
| SFcode | SF job number | Y |
| pay_month | Payroll month | Y |
| attendance_name | attendance type name | Y |
| attendance_nums | Sink total | Y |
| name | Employee name | Y |
| company | corporation | Y |
| deptment | section | Y |
| attendance_type | attendance type | Y |
Request body example
[
{
"end_date": "2023-11-30",
"apply_unit": "小时",
"category_name": "休假",
"create_time": "2023-12-22 18:15:58.000",
"category_code": "LV",
"begin_date": "2023-11-01",
"SFcode": "100300000",
"pay_month": "202312",
"attendance_name": "病假(SCH)",
"attendance_nums": 176.0,
"name": "马化腾",
"company": "SCH",
"deptment": "DPTtx001",
"attendance_type": "B01"
},
{
"end_date": "2023-11-30",
"apply_unit": "小时",
"category_name": "工时",
"create_time": "2023-12-22 18:15:58.000",
"category_code": "WH",
"begin_date": "2023-11-01",
"SFcode": "30000008",
"pay_month": "202312",
"attendance_name": "排班工时",
"attendance_nums": 176.0,
"name": "余承东",
"company": "SCH",
"deptment": "DPTWH001",
"attendance_type": "I02"
}
]Response body example
success response:
{
"success": true,
"message": "reveived 131 data."
}error response:
{
"success": false,
"error": "error message"
}3.3 Instant get attendance data
Interface Request: /api/v1/attendance
Interface Description: This interface is used to obtain the archived attendance data.
Request method: GET
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| salary_month | Salary month (yyyyMM), e.g. 202405 | Y |
| sf_code | Employee number | N |
| company | company code | N |
| deptment | deptment code | N |
Request param example
https://schm-api-dev.shiseido.cn/schm-hr-eapi/api/v1/attendance?pay_month=202309Response body example
[
{
"SFcode": "100001",
"name": "chuan c lin",
"company": "SCH",
"deptment": "ShouFaShi",
"pay_month": "202309",
"begin_date": "2023-08-01T00:00:00",
"end_date": "2023-08-31T00:00:00",
"category_code": "WH",
"category_name": "工时",
"attendance_type": "x1",
"attendance_name": "当月工作天数",
"attendance_nums": 23,
"apply_unit": "d"
},
{
"SFcode": "100001",
"name": "chuan c lin",
"company": "SCH",
"deptment": "ShouFaShi",
"pay_month": "202309",
"begin_date": "2023-08-01T00:00:00",
"end_date": "2023-08-31T00:00:00",
"category_code": "WH",
"category_name": "工时",
"attendance_type": "x2",
"attendance_name": "加班天数",
"attendance_nums": 23,
"apply_unit": "d"
}
]3.4 Manually sync payroll data.
Interface Request: /api/v1/salary/sync
Interface Description: Manually synchronize payroll data. Normally payroll data is automatically synchronized periodically. This interface is used to record payroll data.
Request method: POST
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| startTime | salary data begin date | Y |
| endTime | salary data end date | Y |
Request body example
{
"startTime": "2024-02-01",
"endTime": "2024-03-01"
}Response body example
success response:
{
"success": true,
"message": "reveived 131 data."
}error response:
{
"success": false,
"error": "error message"
}3.5 employee information query
Interface Request: /api/v1/sf/employee
Interface Description: successfactors employee information Interface.
Request method: GET
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| pageSize | Number of entries returned per page, default 10 | N |
| pageNo | page number default 0 | N |
| last_modified_date_time | query last updatetime after this value | N |
Request body example
https://schm-api.shiseido.cn/schm-hr-eapi/api/v1/sf/employee?pageSize=10&pageNo=0pageNo can be understood as "number of pages to be skipped", and the results displayed are the data after pageNo x pageSize. So if you want to display the first page of data, then pageNo is 0.
Response body Description
| mulesoft column | SuccessFactors entity | SuccessFactors column | column description |
|---|---|---|---|
| person_id | PerPerson | personIdExternal | Employee number |
| last_modified_date_time | N/A | N/A | Total data last update date. This value is the latest update time of all entities. It is also the field in the parameter condition to make the decision |
| perperson_last_modified_date_time | PerPerson | lastModifiedDateTime | Last update time of PerPerson |
| date_of_birth | PerPerson | dateOfBirth | Date of birth |
| preferred_last_name | PerPersonal | customString1 | English surname |
| formal_full_name | PerPersonal | customString2 | English name |
| first_name | PerPersonal | firstName | English name |
| gender | PerPersonal | gender | sex |
| gender_value | PerPersonal | gender | Gender (escaped by pickList) |
| age | PerPersonal | age | age |
| last_name | PerPersonal | lastName | English name |
| marital_status_id | PerPersonal | maritalStatus | Marital status (sf original) |
| marital_status | PerPersonal | maritalStatus | Marital status |
| marital_status_value | PerPersonal | maritalStatus | Marital status (escaped by pickList) |
| nationality | PerPersonal | nationality | nationality |
| preferred_first_name | PerPersonal | preferredName | Address sb. respectfully |
| last_name_alt1 | PerPersonal | lastNameAlt1 | Chinese surname |
| first_name_alt1 | PerPersonal | firstNameAlt1 | Chinese name |
| last_name_alt2 | PerPersonal | lastNameAlt2 | Chinese surname (alternate) |
| first_name_alt2 | PerPersonal | firstNameAlt2 | Chinese name (alternate) |
| last_name_cn | PerPersonal | lastNameAlt1 or lastNameAlt2 | The lastNameAlt1 or lastNameAlt2 is Chinese |
| first_name_cn | PerPersonal | firstNameAlt1 or firstNameAlt2 | firstNameAlt1 or firstNameAlt2 is Chinese |
| formalName | PerPersonal | formalName | English name |
| perpersonal_last_modified_date_time | PerPersonal | lastModifiedDateTime | PerPersonal last updated time |
| national_id | PerNationalId | nationalId | Id number |
| national_id_card_type | PerNationalId | cardType | Document type |
| national_id_region | PerNationalId | country | Country/region |
| national_id_is_primary | PerNationalId | isPrimary | main |
| national_id_expiration_date | PerNationalId | customDate1 | Due date |
| national_id_issue_date | PerNationalId | customDate2 | Date of issue |
| national_id_issuing_authority | PerNationalId | customString1 | License issuing authority |
| email_type | PerEmail | emailType | Mailbox type |
| email_address | PerEmail | emailAddress | Company email, personal email |
| is_primary | PerEmail | isPrimary | main |
| phone_type | PerPhone | phoneType | Company phone, cell phone |
| extension | PerPhone | extension | extension |
| phone_number | PerPhone | phoneNumber | Company phone, cell phone |
| country_code | PerPhone | countryCode | Country code |
| region_code | PerPhone | customString6 | Country/region |
| country_code | PerPhone | countryCode | Country code |
| region_code | PerPhone | customString6 | Country/region |
| address_type | PerAddressDEFLT | addressType | Permanent address, domicile address |
| detailed | PerAddressDEFLT | address1 | Detailed address |
| street | PerAddressDEFLT | address2 | street |
| district | PerAddressDEFLT | address3 | County/region |
| country | PerAddressDEFLT | country | Country/region |
| province | PerAddressDEFLT | state | Province/municipality |
| city | PerAddressDEFLT | city | The city |
| effective_start_date | PaymentInformationV3 | effectiveStartDate | Effective date |
| account_number | PaymentInformationDetailV3 | accountNumber | Bank account number |
| account_owner | PaymentInformationDetailV3 | accountOwner | Account holder |
| bank | PaymentInformationDetailV3 | bank | Bank name |
| name | PerEmergencyContacts | name | name |
| relationship | PerEmergencyContacts | relationship | relation |
| phone | PerEmergencyContacts | phone | Mobile phone number |
| province_of_hukou_id | PerGlobalInfoCHN | customString1 | Account location (sf original value) |
| province_of_hukou | PerGlobalInfoCHN | customString1 | domicile |
| province_of_hukou_value | PerGlobalInfoCHN | customString1 | Domicile (escaped by pickList) |
| city_of_hukou_id | PerGlobalInfoCHN | customString2 | Account location (sf original value) |
| city_of_hukou | PerGlobalInfoCHN | customString2 | domicile |
| city_of_hukou_value | PerGlobalInfoCHN | customString2 | Domicile (escaped by pickList) |
| place_of_hukou | PerGlobalInfoCHN | customString3 | domicile |
| level_of_challenge | PerGlobalInfoCHN | customString4 | Disability class |
| hukou_type_id | PerGlobalInfoCHN | genericNumber1 | Nature of Account (SCH, SZC)(sf original value) |
| hukou_type | PerGlobalInfoCHN | genericNumber1 | Nature of household registration (SCH, SZC) |
| hukou_type_value | PerGlobalInfoCHN | genericNumber1 | Nature of account (SCH, SZC)(escaped by pickList) |
| type_of_challenge_id | PerGlobalInfoCHN | genericString2 | Disability Description (sf original) |
| type_of_challenge | PerGlobalInfoCHN | genericString2 | Disability description |
| type_of_challenge_value | PerGlobalInfoCHN | genericString2 | Disability description (escaped by pickList) |
| reference_number | PerGlobalInfoCHN | genericString4 | Disability or not |
| ethnic_group | PerGlobalInfoCHN | genericNumber4 | nation |
| number_of_children | PerGlobalInfoCHN | genericNumber5 | Number of children |
| political_status | PerGlobalInfoCHN | customString5 | Political status |
| date_of_marriage | PerGlobalInfoCHN | customDate1 | Wedding date |
| userId | EmpEmployment | userId | User coding |
| probation_period_end_date | EmpEmployment | customDate1 | Trial end date |
| social_insurance_payment_date | EmpEmployment | customDate23 | Social security payment date |
| original_start_date | EmpEmployment | originalStartDate | Social seniority begins to count |
| service_date | EmpEmployment | ServiceDate | Social seniority begins to count |
| seniority_start_date | EmpEmployment | seniorityDate | Effective date of employment |
| probation_start_date | EmpEmployment | startDate | Employment day |
| legacy_hris_id | EmpEmployment | customString11 | HRM Employee Number |
| probation_start_date | EmpEmployment | startDate | Date of entry |
| probation_period_number | EmpEmployment | customDouble1 | Probation period |
| probation_period_frequency | EmpEmployment | customString1 | Probationary unit |
| probation_status | EmpEmployment | customString2 | Trial status |
| entry_into_group | EmpEmployment | customDate2 | Date of joining the group |
| rel_user_id | EmpJobRelationships | relUserId | HRBP employee number |
| job_level_id | EmpJob | customString92 | Personnel Level (sf original) |
| job_level | EmpJob | customString92 | Personnel level |
| job_level_value | EmpJob | customString92 | Personnel level (escaped by pickList) |
| startdate | EmpJob | startDate | Departmental change date |
| company | EmpJob | company | corporation |
| division | EmpJob | division | This department |
| department | EmpJob | department | Department, subdepartment, team, group |
| parent_department | FODepartment | department | Superior department |
| department_description | EmpJob | Brand POS code | |
| individual_global_grade | EmpJob | customString103 | Individual Global Grade |
| contract_start_date | EmpJob | customDate1 | Contract commencement date |
| contract_end_date | EmpJob | contractEndDate | Contract end date |
| contract_type_id | EmpJob | contractType | No fixed term (sf original) |
| contract_type | EmpJob | contractType | open-ended |
| contract_type_value | EmpJob | contractType | No fixed term (escaped by pickList) |
| cost_center | EmpJob | costCenter | Cost center category |
| health_certificate_effective_date | EmpJob | customDate6 | Health certificate issuing date |
| health_certificate_expiration_date | EmpJob | customDate7 | Health certificate expiration date |
| health_certificate | EmpJob | customString121 | Health certificate |
| attendance_type_id | EmpJob | customString122 | Time system (sf original value) |
| attendance_type | EmpJob | customString122 | Working hour system |
| attendance_type_value | EmpJob | customString122 | Time system (escaped by pickList) |
| job_family_id | EmpJob | customString15 | Class Group (sf original value) |
| job_family | EmpJob | customString15 | Class group |
| job_family_value | EmpJob | customString15 | Job group (escaped by pickList) |
| brand | EmpJob | customString59 | brand |
| employee_class_id | EmpJob | employeeClass | Employee Category (sf original value) |
| employee_class | EmpJob | employeeClass | Employee category |
| employee_class_value | EmpJob | employeeClass | Employee category (escaped by pickList) |
| event_reason | EmpJob | eventReason | RNS |
| event_date | EmpJob | startdate | Transaction effective date |
| job_classification | EmpJob | jobCode | Rank, take the position |
| location | EmpJob | location | Region (translated by FOLocation) |
| location_code | EmpJob | location | Region (SF original value) |
| subsidy_criteria_id | EmpJob | customString128 | Job qualification (sf original value) |
| subsidy_criteria | EmpJob | customString128 | Post qualification |
| subsidy_criteria_value | EmpJob | customString128 | Job qualification (escaped by pickList) |
| admin_or_trade_id | EmpJob | customString125 | admin or trade(sf original value) |
| admin_or_trade | EmpJob | customString125 | admin or trade |
| admin_or_trade_value | EmpJob | customString125 | admin or trade(escaped by pickList) |
| position | EmpJob | position | Job code |
| position_entry_date | EmpJob | positionEntryDate | Job start date |
| manager | EmpJob | managerId | Line supervisor |
| event | EmpJob | event | incident |
| event_code | EmpJob | event | Event (externalCode corresponding to pickList) |
| job_function | EmpJob | customString16 | Post function |
| grade_shk | EmpJob | payGrade | Hong Kong ranks |
| employee_type | EmpJob | employeeType | Employee type |
| local_job_title | EmpJob | localJobTitle | Local job title |
| public_job_title_eng | EmpJob | jobTitle | English job title |
| mode_of_employment_id | EmpJob | customString160 | Employment Mode (SCS)(sf original) |
| mode_of_employment | EmpJob | customString160 | Employment Model (SCS) |
| mode_of_employment_value | EmpJob | customString160 | Employment Mode (SCS)(escaped by pickList) |
| branch_office | EmpJob | customString2 | Default branch code |
| positionNav_externalName_defaultValue | EmpJob | positionNav_externalName | Job Description c_title |
| employment_status_id | EmpJob | emplStatus | Active status (sf original) |
| employment_status_code | EmpJob | emplStatus | On-the-job status |
| employment_status_value | EmpJob | emplStatus | Active status (escaped by pickList) |
| empjob_last_modified_date_time | EmpJob | lastModifiedDateTime | Time when EmpJob was last updated |
| compensation_startDate | EmpCompensation | startDate | The effective date of the salary system |
| pay_group | EmpCompensation | payGroup | Salary system |
| pay_component | EmpPayCompRecurring | payComponent | Wage structure/type of pay |
| currency | EmpPayCompRecurring | currencyCode | currency |
| frequency | EmpPayCompRecurring | frequency | frequency |
| amount | EmpPayCompRecurring | paycompvalue | amount |
| recurring_startDate | EmpPayCompRecurring | startDate | Effective commencement date |
| termination_Date | EmpEmploymentTermination | endDate | Resignation date |
| termination_reason | EmpEmploymentTermination | eventReason | Reason for resignation |
| last_date_worked | EmpEmploymentTermination | lastDateWorked | Last working date |
| empemploymenttermination_last_modified_date_time | EmpEmploymentTermination | lastModifiedDateTime | EmpEmploymentTermination Last Update time |
Response body example
[
{
"person_id": "10030227",
"last_modified_date_time": "2022-03-21T13:36:10",
"perperson_last_modified_date_time": "2021-05-05T11:49:44",
"date_of_birth": "1974-05-29T00:00:00",
"preferred_last_name": "SHEN",
"formal_full_name": "Yu SHEN",
"first_name": "Yu",
"gender": "F",
"gender_value": "女",
"last_name": "SHEN",
"marital_status_id": "1892",
"marital_status": "M",
"marital_status_value": "已婚",
"nationality": "CHN",
"preferred_first_name": "Yu",
"last_name_alt1": "沈",
"first_name_alt1": "矞",
"last_name_alt2": "SHEN",
"first_name_alt2": "Yu",
"last_name_cn": "沈",
"first_name_cn": "矞",
"formalName": "Yu SHEN",
"perpersonal_last_modified_date_time": "2021-05-05T19:03:46",
"national_id": "320626197405293028",
"national_id_card_type": "ResidentIdCard",
"national_id_region": "CHN",
"national_id_is_primary": 1,
"national_id_expiration_date": null,
"national_id_issue_date": null,
"national_id_issuing_authority": null,
"Effective_start_date": null,
"account_number": "1001082901211162316",
"account_owner": "沈矞",
"bank": "CN_ICBC",
"province_of_hukou_id": null,
"province_of_hukou": null,
"province_of_hukou_value": null,
"city_of_hukou_id": null,
"city_of_hukou": null,
"city_of_hukou_value": null,
"place_of_hukou": null,
"level_of_challenge": null,
"hukou_type_id": null,
"hukou_type": null,
"hukou_type_value": null,
"type_of_challenge_id": null,
"type_of_challenge": null,
"type_of_challenge_value": null,
"reference_number": null,
"ethnic_group": null,
"number_of_children": null,
"political_status": null,
"date_of_marriage": null,
"userId": "10030227",
"probation_period_end_date": null,
"social_insurance_payment_date": null,
"original_start_date": null,
"service_date": null,
"seniority_start_date": "2001-10-26T00:00:00",
"probation_start_date": "2001-10-26T00:00:00",
"legacy_hris_id": "00000214",
"probation_period_number": null,
"probation_period_frequency": null,
"probation_status": null,
"entry_into_group": "2001-10-26T00:00:00",
"job_level_id": "7633",
"job_level": "NM",
"job_level_value": "非经理",
"startdate": "2022-03-12T00:00:00",
"company": "C0100",
"division": "60020103",
"department": "60020823",
"contract_start_date": "2013-10-26T00:00:00",
"contract_end_date": "9999-12-31T00:00:00",
"contract_type_id": "290234",
"contract_type": "CHN-NF",
"contract_type_value": "无固定期限",
"cost_center": "A11YI1TZZZ",
"health_certificate_effective_date": null,
"health_certificate_expiration_Date": null,
"health_certificate": null,
"attendance_type_id": null,
"attendance_type": "289649",
"attendance_type_value": null,
"job_family_id": null,
"job_family": "60000006",
"job_family_value": null,
"brand": "CS",
"employee_class_id": "1256",
"employee_class": "P",
"employee_class_value": "正式员工(无固定期限)",
"event_reason": "TERMEND",
"job_classification": "NONE",
"location": "上海",
"subsidy_criteria_id": null,
"subsidy_criteria": null,
"subsidy_criteria_value": null,
"position": "50210220",
"position_entry_date": "2021-01-01T00:00:00",
"manager": "10030210",
"event": "1934",
"job_function": "60000104",
"grade_shk": null,
"employee_type": "7749",
"local_job_title": "培训担当",
"public_job_title_eng": "Training Specialist",
"mode_of_employment_id": null,
"mode_of_employment": null,
"mode_of_employment_value": null,
"branch_office": null,
"positionNav_externalName_defaultValue": "Training Specialist",
"employment_status_id": "1902",
"employment_status_code": "T",
"employment_status_value": "已离职",
"empjob_last_modified_date_time": "2022-03-02T08:31:32",
"compensation_startDate": "2022-03-01T00:00:00",
"pay_group": "CHN_SCH_1",
"pay_component": "60000114",
"currency": "CNY",
"frequency": "60000010",
"amount": 10150.0,
"recurring_startDate": "2022-03-01T00:00:00",
"termination_Date": "2022-03-11T00:00:00",
"last_date_worked": "2022-03-11T00:00:00",
"termination_sub_reason": null,
"empemploymenttermination_last_modified_date_time": "2022-03-02T08:31:30",
"email": [
{
"email_type": "B",
"email_type_value": "公司",
"email_address": "shenyu@shiseido.cn",
"personIdExternal": "10030227",
"is_primary": 1,
"last_modified_date_time": "2021-05-05T19:06:55"
}
],
"phone": [
{
"phone_type": "B",
"phone_type_value": "公司",
"extension": null,
"phone_number": "021-xxxxxx",
"country_code": "5239",
"region_code": "44",
"personIdExternal": "10030227",
"last_modified_date_time": "2021-12-24T11:45:14"
},
{
"phone_type": "P",
"phone_type_value": "个人手机",
"extension": null,
"phone_number": "xxxxxx",
"country_code": "5239",
"region_code": "44",
"personIdExternal": "10030227",
"last_modified_date_time": "2021-05-05T19:06:45"
}
],
"address": [],
"contacts": []
}
]All values ending in _value are the actual mapped values for the picklist that correspond to values without _value.
The following is the mapping between employee status dictionaries.
| externalCode | optionId | label_zh_CN | label_defaultValue |
|---|---|---|---|
| A | 1910 | 在职 | Active |
| D | 1909 | 非活动 | Dormant |
| F | 1906 | 暂时解雇 | Furlough |
| O | 1905 | 已取消 | Cancelled |
| P | 1908 | 带薪假 | Paid Leave |
| R | 1907 | 已退休 | Retired |
| S | 1903 | 已暂停 | Suspended |
| T | 1902 | 已离职 | Inactive |
| U | 1904 | 无薪休假 | Unpaid Leave |
| RNS | 273564 | 已报告不出现 | Reported No Show |
3.6 Regional information query
Interface Request: /api/v1/sf/division
Interface Description: Querying area information.
Request method: GET
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| pageSize | Number of entries returned per page, default 10 | N |
| pageNo | page number default 0 | N |
| lastModifiedDateTime | Filter data that was last updated later than this time. | N |
| externalCode | query by externalCode | N |
| status | query by status | N |
Request body example
https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/sf/division?pageSize=10&pageNo=0pageNo can be understood as "number of pages to be skipped", and the results displayed are the data after pageNo x pageSize. So if you want to display the first page of data, then pageNo is 0.
only return CHN and HKG data.
The cust_LegalEntity returns its owning company.If there are more than one, they are separated by commas (,).
Response body example
[
{
"headOfUnit": null,
"name_en_US": "General Manager",
"lastModifiedDateTime": "2021-05-04T08:03:47Z",
"externalCode": "60020501",
"cust_ParentDivision": null,
"name": "General Manager",
"createdDateTime": "2021-05-04T08:03:47Z",
"startDate": "1998-02-11T00:00:00Z",
"name_zh_CN": "总经理",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Administration Division",
"lastModifiedDateTime": "2021-05-04T08:03:47Z",
"externalCode": "60020502",
"cust_ParentDivision": null,
"name": "Administration Division",
"createdDateTime": "2021-05-04T08:03:47Z",
"startDate": "1998-02-11T00:00:00Z",
"name_zh_CN": "管理本部",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Production Division",
"lastModifiedDateTime": "2021-05-04T08:03:47Z",
"externalCode": "60020503",
"cust_ParentDivision": null,
"name": "Production Division",
"createdDateTime": "2021-05-04T08:03:47Z",
"startDate": "1998-02-11T00:00:00Z",
"name_zh_CN": "生产本部",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Factory Managing Director",
"lastModifiedDateTime": "2021-05-04T08:03:47Z",
"externalCode": "60020504",
"cust_ParentDivision": null,
"name": "Factory Managing Director",
"createdDateTime": "2021-05-04T08:03:47Z",
"startDate": "1998-02-11T00:00:00Z",
"name_zh_CN": "工场长",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Shiseido China Innovation Center",
"lastModifiedDateTime": "2021-05-04T02:44:41Z",
"externalCode": "60020001",
"cust_ParentDivision": null,
"name": "Shiseido China Innovation Center",
"createdDateTime": "2021-05-04T02:44:41Z",
"startDate": "2001-12-18T00:00:00Z",
"name_zh_CN": "资生堂中国研发中心",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Digital Transformation Office",
"lastModifiedDateTime": "2021-05-05T10:26:46Z",
"externalCode": "60020117",
"cust_ParentDivision": null,
"name": "Digital Transformation Office",
"createdDateTime": "2021-05-05T10:26:46Z",
"startDate": "2003-12-24T00:00:00Z",
"name_zh_CN": "Digital Transformation Office",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Beauty Device Department",
"lastModifiedDateTime": "2021-05-05T10:26:46Z",
"externalCode": "60020121",
"cust_ParentDivision": null,
"name": "Beauty Device Department",
"createdDateTime": "2021-05-05T10:26:46Z",
"startDate": "2003-12-24T00:00:00Z",
"name_zh_CN": "Beauty Device Department",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Brand Shiseido Department",
"lastModifiedDateTime": "2021-05-05T10:26:46Z",
"externalCode": "60020122",
"cust_ParentDivision": null,
"name": "Brand Shiseido Department",
"createdDateTime": "2021-05-05T10:26:46Z",
"startDate": "2003-12-24T00:00:00Z",
"name_zh_CN": "Brand Shiseido Department",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Emerging Brands Department",
"lastModifiedDateTime": "2021-05-05T10:26:46Z",
"externalCode": "60020123",
"cust_ParentDivision": null,
"name": "Emerging Brands Department",
"createdDateTime": "2021-05-05T10:26:46Z",
"startDate": "2003-12-24T00:00:00Z",
"name_zh_CN": "Emerging Brands Department",
"status": "A",
"cust_LegalEntity": "C0101"
},
{
"headOfUnit": null,
"name_en_US": "Business Development Department",
"lastModifiedDateTime": "2021-05-05T10:26:46Z",
"externalCode": "60020128",
"cust_ParentDivision": null,
"name": "Business Development Department",
"createdDateTime": "2021-05-05T10:26:46Z",
"startDate": "2003-12-24T00:00:00Z",
"name_zh_CN": "Business Development Department",
"status": "A",
"cust_LegalEntity": "C0101"
}
]
3.7 Department information query
Interface Request: /api/v1/sf/department
Interface Description: Query departmental information from successfactors.
Request method: GET
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| pageSize | Number of entries returned per page, default 10 | N |
| pageNo | page number default 0 | N |
| lastModifiedDateTime | Filter data that was last updated later than this time. | N |
| externalCode | query by externalCode | N |
| status | query by status | N |
Request body example
https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/sf/department?pageSize=10&pageNo=0pageNo can be understood as "number of pages to be skipped", and the results displayed are the data after pageNo x pageSize. So if you want to display the first page of data, then pageNo is 0.
only return CHN and HKG data.
The cust_LegalEntity returns its owning company.If there are more than one, they are separated by commas (,).
The cust_Division returns its parent department.If there are more than one, they are separated by commas (,).
Response body example
[
{
"cust_orgOfficialNameEN": null,
"parent": "60020001",
"description_ko_KR": null,
"lastModifiedDateTime": "2021-10-21T06:53:16",
"name_localized": "President & C.O.O.",
"externalCode": "60020001",
"description_th_TH": null,
"endDate": "9999-12-31T00:00:00",
"entityUUID": "2EEF463BA5F64B84A31DFDF25CF7BDEB",
"name_ko_KR": null,
"createdDateTime": "2021-05-04T03:14:59",
"name_th_TH": null,
"description_pt_BR": null,
"cust_orgIdForInterface": null,
"description_es_ES": null,
"name_pt_BR": null,
"description_nl_NL": null,
"cust_deptLevel": null,
"name_nl_NL": null,
"costCenter": "NONE",
"description_defaultValue": "301",
"cust_orgOfficialNameJA": null,
"cust_orgNameForInterfaceEN2": null,
"name_de_DE": null,
"cust_orgNameForInterfaceEN3": null,
"name_zh_TW": null,
"cust_orgNameForInterfaceEN1": null,
"name": "President & C.O.O.",
"name_es_ES": null,
"description_en_US": "301",
"cust_orgNameForInterfaceEN4": null,
"cust_orgNameForInterfaceEN5": null,
"description_en_DEBUG": null,
"startDate": "2001-12-18T00:00:00",
"description_it_IT": null,
"description_ru_RU": null,
"status": "A",
"name_ru_RU": null,
"description_ja_JP": null,
"description_fr_FR": null,
"name_it_IT": null,
"description": "301",
"description_de_DE": null,
"name_fr_FR": null,
"name_en_DEBUG": null,
"name_ja_JP": null,
"createdOn": "2021-05-04T05:14:59",
"cust_organizationalRegion": null,
"headOfUnit": null,
"name_en_US": "President & C.O.O.",
"description_zh_TW": null,
"name_zh_CN": "总经理",
"name_defaultValue": "President & C.O.O.",
"cust_orgNameForInterfaceJA1": null,
"description_bs_ID": null,
"description_en_GB": null,
"lastModifiedBy": "10032859",
"cust_orgNameForInterfaceJA4": null,
"cust_orgNameForInterfaceJA5": null,
"cust_orgNameForInterfaceJA2": null,
"cust_orgNameForInterfaceJA3": null,
"name_en_GB": null,
"name_vi_VN": null,
"lastModifiedOn": "2021-10-21T08:53:16",
"description_vi_VN": null,
"description_zh_CN": null,
"createdBy": "CN_DM_USER",
"mdfSystemRecordId": "32E7EBCA47314794ABF48A9CC396563E",
"description_localized": "301",
"name_bs_ID": null,
"cust_DivisionProp": "60020001",
"cust_LegalEntityProp": "H0700"
},
{
"cust_orgOfficialNameEN": null,
"parent": "60020001",
"description_ko_KR": null,
"lastModifiedDateTime": "2021-10-21T06:53:33",
"name_localized": "Vice President",
"externalCode": "60020002",
"description_th_TH": null,
"endDate": "9999-12-31T00:00:00",
"entityUUID": "08C8EF889A924C9F9B549B095835203C",
"name_ko_KR": null,
"createdDateTime": "2021-05-04T03:14:59",
"name_th_TH": null,
"description_pt_BR": null,
"cust_orgIdForInterface": null,
"description_es_ES": null,
"name_pt_BR": null,
"description_nl_NL": null,
"cust_deptLevel": null,
"name_nl_NL": null,
"costCenter": "NONE",
"description_defaultValue": "302",
"cust_orgOfficialNameJA": null,
"cust_orgNameForInterfaceEN2": null,
"name_de_DE": null,
"cust_orgNameForInterfaceEN3": null,
"name_zh_TW": null,
"cust_orgNameForInterfaceEN1": null,
"name": "Vice President",
"name_es_ES": null,
"description_en_US": "302",
"cust_orgNameForInterfaceEN4": null,
"cust_orgNameForInterfaceEN5": null,
"description_en_DEBUG": null,
"startDate": "2001-12-18T00:00:00",
"description_it_IT": null,
"description_ru_RU": null,
"status": "A",
"name_ru_RU": null,
"description_ja_JP": null,
"description_fr_FR": null,
"name_it_IT": null,
"description": "302",
"description_de_DE": null,
"name_fr_FR": null,
"name_en_DEBUG": null,
"name_ja_JP": null,
"createdOn": "2021-05-04T05:14:59",
"cust_organizationalRegion": null,
"headOfUnit": null,
"name_en_US": "Vice President",
"description_zh_TW": null,
"name_zh_CN": "副总经理(北京)",
"name_defaultValue": "Vice President",
"cust_orgNameForInterfaceJA1": null,
"description_bs_ID": null,
"description_en_GB": null,
"lastModifiedBy": "10032859",
"cust_orgNameForInterfaceJA4": null,
"cust_orgNameForInterfaceJA5": null,
"cust_orgNameForInterfaceJA2": null,
"cust_orgNameForInterfaceJA3": null,
"name_en_GB": null,
"name_vi_VN": null,
"lastModifiedOn": "2021-10-21T08:53:33",
"description_vi_VN": null,
"description_zh_CN": null,
"createdBy": "CN_DM_USER",
"mdfSystemRecordId": "EE204D1BE90F4CAABFF28C6F4C4FA398",
"description_localized": "302",
"name_bs_ID": null,
"cust_DivisionProp": "60020001",
"cust_LegalEntityProp": "H0700"
},
{
"cust_orgOfficialNameEN": null,
"parent": "60020001",
"description_ko_KR": null,
"lastModifiedDateTime": "2021-10-21T06:53:49",
"name_localized": "Administration Department",
"externalCode": "60020003",
"description_th_TH": null,
"endDate": "9999-12-31T00:00:00",
"entityUUID": "A90A18EEC0C3407FA16331537557457F",
"name_ko_KR": null,
"createdDateTime": "2021-05-04T03:14:59",
"name_th_TH": null,
"description_pt_BR": null,
"cust_orgIdForInterface": null,
"description_es_ES": null,
"name_pt_BR": null,
"description_nl_NL": null,
"cust_deptLevel": null,
"name_nl_NL": null,
"costCenter": "NONE",
"description_defaultValue": "304",
"cust_orgOfficialNameJA": null,
"cust_orgNameForInterfaceEN2": null,
"name_de_DE": null,
"cust_orgNameForInterfaceEN3": null,
"name_zh_TW": null,
"cust_orgNameForInterfaceEN1": null,
"name": "Administration Department",
"name_es_ES": null,
"description_en_US": "304",
"cust_orgNameForInterfaceEN4": null,
"cust_orgNameForInterfaceEN5": null,
"description_en_DEBUG": null,
"startDate": "2001-12-18T00:00:00",
"description_it_IT": null,
"description_ru_RU": null,
"status": "A",
"name_ru_RU": null,
"description_ja_JP": null,
"description_fr_FR": null,
"name_it_IT": null,
"description": "304",
"description_de_DE": null,
"name_fr_FR": null,
"name_en_DEBUG": null,
"name_ja_JP": null,
"createdOn": "2021-05-04T05:14:59",
"cust_organizationalRegion": null,
"headOfUnit": null,
"name_en_US": "Administration Department",
"description_zh_TW": null,
"name_zh_CN": "经营管理部",
"name_defaultValue": "Administration Department",
"cust_orgNameForInterfaceJA1": null,
"description_bs_ID": null,
"description_en_GB": null,
"lastModifiedBy": "10032859",
"cust_orgNameForInterfaceJA4": null,
"cust_orgNameForInterfaceJA5": null,
"cust_orgNameForInterfaceJA2": null,
"cust_orgNameForInterfaceJA3": null,
"name_en_GB": null,
"name_vi_VN": null,
"lastModifiedOn": "2021-10-21T08:53:49",
"description_vi_VN": null,
"description_zh_CN": null,
"createdBy": "CN_DM_USER",
"mdfSystemRecordId": "07B1FC06D59D4C81BBD130C3190027EB",
"description_localized": "304",
"name_bs_ID": null,
"cust_DivisionProp": "60020001",
"cust_LegalEntityProp": "H0700"
},
{
"cust_orgOfficialNameEN": null,
"parent": "60020001",
"description_ko_KR": null,
"lastModifiedDateTime": "2021-10-21T06:54:03",
"name_localized": "Product Development Department(Beijing)",
"externalCode": "60020004",
"description_th_TH": null,
"endDate": "9999-12-31T00:00:00",
"entityUUID": "008B26EBC56A4E279FC9D0E5E47A3980",
"name_ko_KR": null,
"createdDateTime": "2021-05-04T03:14:59",
"name_th_TH": null,
"description_pt_BR": null,
"cust_orgIdForInterface": null,
"description_es_ES": null,
"name_pt_BR": null,
"description_nl_NL": null,
"cust_deptLevel": null,
"name_nl_NL": null,
"costCenter": "NONE",
"description_defaultValue": "305",
"cust_orgOfficialNameJA": null,
"cust_orgNameForInterfaceEN2": null,
"name_de_DE": null,
"cust_orgNameForInterfaceEN3": null,
"name_zh_TW": null,
"cust_orgNameForInterfaceEN1": null,
"name": "Product Development Department(Beijing)",
"name_es_ES": null,
"description_en_US": "305",
"cust_orgNameForInterfaceEN4": null,
"cust_orgNameForInterfaceEN5": null,
"description_en_DEBUG": null,
"startDate": "2001-12-18T00:00:00",
"description_it_IT": null,
"description_ru_RU": null,
"status": "A",
"name_ru_RU": null,
"description_ja_JP": null,
"description_fr_FR": null,
"name_it_IT": null,
"description": "305",
"description_de_DE": null,
"name_fr_FR": null,
"name_en_DEBUG": null,
"name_ja_JP": null,
"createdOn": "2021-05-04T05:14:59",
"cust_organizationalRegion": null,
"headOfUnit": null,
"name_en_US": "Product Development Department(Beijing)",
"description_zh_TW": null,
"name_zh_CN": "制品开发部(北京)",
"name_defaultValue": "Product Development Department(Beijing)",
"cust_orgNameForInterfaceJA1": null,
"description_bs_ID": null,
"description_en_GB": null,
"lastModifiedBy": "10032859",
"cust_orgNameForInterfaceJA4": null,
"cust_orgNameForInterfaceJA5": null,
"cust_orgNameForInterfaceJA2": null,
"cust_orgNameForInterfaceJA3": null,
"name_en_GB": null,
"name_vi_VN": null,
"lastModifiedOn": "2021-10-21T08:54:03",
"description_vi_VN": null,
"description_zh_CN": null,
"createdBy": "CN_DM_USER",
"mdfSystemRecordId": "7F1789A90556436EA077E915400AD0EC",
"description_localized": "305",
"name_bs_ID": null,
"cust_DivisionProp": "60020001",
"cust_LegalEntityProp": "H0700"
},
{
"cust_orgOfficialNameEN": null,
"parent": "60020001",
"description_ko_KR": null,
"lastModifiedDateTime": "2021-12-24T06:10:53",
"name_localized": "Quality Assessment Department",
"externalCode": "60020005",
"description_th_TH": null,
"endDate": "9999-12-31T00:00:00",
"entityUUID": "124DAF15B17A42D3B9345CBD8F4E7CCB",
"name_ko_KR": null,
"createdDateTime": "2021-12-24T06:10:53",
"name_th_TH": null,
"description_pt_BR": null,
"cust_orgIdForInterface": null,
"description_es_ES": null,
"name_pt_BR": null,
"description_nl_NL": null,
"cust_deptLevel": null,
"name_nl_NL": null,
"costCenter": "NONE",
"description_defaultValue": "306",
"cust_orgOfficialNameJA": null,
"cust_orgNameForInterfaceEN2": null,
"name_de_DE": null,
"cust_orgNameForInterfaceEN3": null,
"name_zh_TW": null,
"cust_orgNameForInterfaceEN1": null,
"name": "Quality Assessment Department",
"name_es_ES": null,
"description_en_US": "306",
"cust_orgNameForInterfaceEN4": null,
"cust_orgNameForInterfaceEN5": null,
"description_en_DEBUG": null,
"startDate": "2022-01-01T00:00:00",
"description_it_IT": null,
"description_ru_RU": null,
"status": "A",
"name_ru_RU": null,
"description_ja_JP": null,
"description_fr_FR": null,
"name_it_IT": null,
"description": "306",
"description_de_DE": null,
"name_fr_FR": null,
"name_en_DEBUG": null,
"name_ja_JP": null,
"createdOn": "2021-12-24T07:10:53",
"cust_organizationalRegion": null,
"headOfUnit": null,
"name_en_US": "Quality Assessment Department",
"description_zh_TW": null,
"name_zh_CN": "品质评价部",
"name_defaultValue": "Quality Assessment Department",
"cust_orgNameForInterfaceJA1": null,
"description_bs_ID": null,
"description_en_GB": null,
"lastModifiedBy": "10032859",
"cust_orgNameForInterfaceJA4": null,
"cust_orgNameForInterfaceJA5": null,
"cust_orgNameForInterfaceJA2": null,
"cust_orgNameForInterfaceJA3": null,
"name_en_GB": null,
"name_vi_VN": null,
"lastModifiedOn": "2021-12-24T07:10:53",
"description_vi_VN": null,
"description_zh_CN": null,
"createdBy": "10032859",
"mdfSystemRecordId": "956633FB46C14C6086BBC6533D3C08FC",
"description_localized": "306",
"name_bs_ID": null,
"cust_DivisionProp": "60020001",
"cust_LegalEntityProp": "H0700"
}
]
3.8 Company information query
Interface Request: /api/v1/sf/company
Interface Description: Query company information from successfactors.
Request method: GET
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| pageSize | Number of entries returned per page, default 10 | N |
| pageNo | page number default 0 | N |
| lastModifiedDateTime | Filter data that was last updated later than this time. | N |
| externalCode | query by externalCode | N |
| status | query by status | N |
Request body example
https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/sf/company?pageSize=10&pageNo=0pageNo can be understood as "number of pages to be skipped", and the results displayed are the data after pageNo x pageSize. So if you want to display the first page of data, then pageNo is 0.
only return CHN and HKG data.
Response body example
[
{
"name_en_US": "Shiseido China Co., Ltd.",
"lastModifiedDateTime": "2023-12-22T05:31:26Z",
"externalCode": "C0100",
"createdDateTime": "2023-11-09T05:53:15Z",
"startDate": "2023-10-01T00:00:00Z",
"name_zh_CN": "资生堂(中国)投资有限公司",
"status": "A"
},
{
"name_en_US": "Shiseido Liyuan Cosmetics Co., Ltd.",
"lastModifiedDateTime": "2023-12-22T05:31:26Z",
"externalCode": "C0200",
"createdDateTime": "2023-11-09T05:53:15Z",
"startDate": "2023-10-01T00:00:00Z",
"name_zh_CN": "资生堂丽源化妆品有限公司",
"status": "A"
},
{
"name_en_US": "Shiseido Hong Kong Limited",
"lastModifiedDateTime": "2023-12-22T05:31:26Z",
"externalCode": "C0300",
"createdDateTime": "2023-11-09T05:53:15Z",
"startDate": "2023-10-01T00:00:00Z",
"name_zh_CN": "資生堂香港有限公司",
"status": "A"
},
{
"name_en_US": "Shiseido Guangdong Cosmetics., Ltd.",
"lastModifiedDateTime": "2023-12-22T05:31:26Z",
"externalCode": "C0500",
"createdDateTime": "2023-11-09T05:53:15Z",
"startDate": "2023-10-01T00:00:00Z",
"name_zh_CN": "资生堂广东化妆品有限公司",
"status": "A"
},
{
"name_en_US": "Shiseido Ziyue (Shanghai) Management Consulting Co., Ltd.",
"lastModifiedDateTime": "2023-12-22T05:31:26Z",
"externalCode": "C0600",
"createdDateTime": "2023-11-09T05:53:15Z",
"startDate": "2023-10-01T00:00:00Z",
"name_zh_CN": "資生堂資悦(上海)管理咨詢有限公司",
"status": "A"
},
{
"name_en_US": "Shiseido Cosmetics Manufacturing Co., LTD.",
"lastModifiedDateTime": "2023-12-22T05:31:26Z",
"externalCode": "H0600",
"createdDateTime": "2023-11-09T05:53:15Z",
"startDate": "2023-10-01T00:00:00Z",
"name_zh_CN": "资生堂化妆品制造有限公司",
"status": "A"
}
]
3.9 Onboarding data query
Interface Request: /api/v1/sf/onboarding
Interface Description: Query onboarding employee data. The current data source is onboarding's SFTP server file.
Request method: GET
This interface is almost identical in structure to the 3.5 employee interface, except that the data content is derived from onboarding data.
onboarding data has no birth_date attribute and returns null consistently.
Request Param Description:
| Field Name | Field Description | required |
|---|---|---|
| pageSize | Number of entries returned per page, default 10 | N |
| pageNo | page number default 0 | N |
| last_modified_date_time | query last updatetime after this value | N |
Request body example
https://schm-api.shiseido.cn/schm-hr-eapi/api/v1/sf/onboarding?pageSize=10&pageNo=0pageNo can be understood as "number of pages to be skipped", and the results displayed are the data after pageNo x pageSize. So if you want to display the first page of data, then pageNo is 0.
Response body Description
| mulesoft column | SuccessFactors entity | SuccessFactors column | column description | |
|---|---|---|---|---|
| person_id | PerPerson | personIdExternal | 员工号 | |
| last_modified_date_time | N/A | N/A | 整体数据最后更新日期，该值取所有entity最后更新时间最新的一个。也是参数条件中进行判定的字段 | |
| perperson_last_modified_date_time | PerPerson | lastModifiedDateTime | PerPerson最后更新时间 | |
| date_of_birth | PerPerson | dateOfBirth | 出生日期 | |
| preferred_last_name | PerPersonal | customString1 | 英文姓 | |
| formal_full_name | PerPersonal | customString2 | 英文姓名 | |
| first_name | PerPersonal | firstName | 英文名 | |
| gender | PerPersonal | gender | 性别 | |
| gender_value | PerPersonal | gender | 性别(经过pickList转义) | |
| last_name | PerPersonal | lastName | 英文名 | |
| marital_status_id | PerPersonal | maritalStatus | 婚姻状况(sf原值) | |
| marital_status | PerPersonal | maritalStatus | 婚姻状况 | |
| marital_status_value | PerPersonal | maritalStatus | 婚姻状况(经过pickList转义) | |
| nationality | PerPersonal | nationality | 国籍 | |
| preferred_first_name | PerPersonal | preferredName | 尊称 | |
| last_name_alt1 | PerPersonal | lastNameAlt1 | 中文姓 | |
| first_name_alt1 | PerPersonal | firstNameAlt1 | 中文名 | |
| last_name_alt2 | PerPersonal | lastNameAlt2 | 中文姓（备用） | |
| first_name_alt2 | PerPersonal | firstNameAlt2 | 中文名（备用） | |
| last_name_cn | PerPersonal | lastNameAlt1 or lastNameAlt2 | 取lastNameAlt1 或lastNameAlt2 中是中文的 | |
| first_name_cn | PerPersonal | firstNameAlt1 or firstNameAlt2 | 取firstNameAlt1或firstNameAlt2中是中文的 | |
| formalName | PerPersonal | formalName | e_name | |
| perpersonal_last_modified_date_time | PerPersonal | lastModifiedDateTime | e_name | PerPersonal |
| national_id | PerNationalId | nationalId | 身份证号 | |
| national_id_card_type | PerNationalId | cardType | 证件类型 | |
| national_id_region | PerNationalId | country | 国家/地区 | |
| national_id_is_primary | PerNationalId | isPrimary | 主要 | |
| national_id_expiration_date | PerNationalId | customDate1 | 到期日期 | |
| national_id_issue_date | PerNationalId | customDate2 | 发证日期 | |
| national_id_issuing_authority | PerNationalId | customString1 | 发证机构 | |
| email_type | PerEmail | emailType | 邮箱类型 | |
| email_address | PerEmail | emailAddress | 公司邮箱、个人电子邮件 | |
| is_primary | PerEmail | isPrimary | 主要 | |
| phone_type | PerPhone | phoneType | 公司电话、手机 | |
| extension | PerPhone | extension | 分机 | |
| phone_number | PerPhone | phoneNumber | 公司电话、手机 | |
| country_code | PerPhone | countryCode | 国家/地区代码 | |
| region_code | PerPhone | customString6 | 国家/地区 | |
| country_code | PerPhone | countryCode | 国家/地区代码 | |
| region_code | PerPhone | customString6 | 国家/地区 | |
| address_type | PerAddressDEFLT | addressType | 常住地址、户籍地址 | |
| detailed | PerAddressDEFLT | address1 | 详细地址 | |
| street | PerAddressDEFLT | address2 | 街道 | |
| district | PerAddressDEFLT | address3 | 县/地区 | |
| country | PerAddressDEFLT | country | 国家/地区 | |
| province | PerAddressDEFLT | state | 省/直辖市 | |
| city | PerAddressDEFLT | city | 市 | |
| effective_start_date | PaymentInformationV3 | effectiveStartDate | 生效日期 | |
| account_number | PaymentInformationDetailV3 | accountNumber | 银行帐号 | |
| account_owner | PaymentInformationDetailV3 | accountOwner | 开户人 | |
| bank | PaymentInformationDetailV3 | bank | 银行名称 | |
| name | PerEmergencyContacts | name | 姓名 | |
| relationship | PerEmergencyContacts | relationship | 关系 | |
| phone | PerEmergencyContacts | phone | 手机号码 | |
| province_of_hukou_id | PerGlobalInfoCHN | customString1 | 户口所在地(sf原值) | |
| province_of_hukou | PerGlobalInfoCHN | customString1 | 户口所在地 | |
| province_of_hukou_value | PerGlobalInfoCHN | customString1 | 户口所在地(经过pickList转义) | |
| city_of_hukou_id | PerGlobalInfoCHN | customString2 | 户口所在地(sf原值) | |
| city_of_hukou | PerGlobalInfoCHN | customString2 | 户口所在地 | |
| city_of_hukou_value | PerGlobalInfoCHN | customString2 | 户口所在地(经过pickList转义) | |
| place_of_hukou | PerGlobalInfoCHN | customString3 | 户口所在地 | |
| level_of_challenge | PerGlobalInfoCHN | customString4 | 残疾等级 | |
| hukou_type_id | PerGlobalInfoCHN | genericNumber1 | 户口性质 (SCH, SZC)(sf原值) | |
| hukou_type | PerGlobalInfoCHN | genericNumber1 | 户口性质 (SCH, SZC) | |
| hukou_type_value | PerGlobalInfoCHN | genericNumber1 | 户口性质 (SCH, SZC)(经过pickList转义) | |
| type_of_challenge_id | PerGlobalInfoCHN | genericString2 | 残疾描述(sf原值) | |
| type_of_challenge | PerGlobalInfoCHN | genericString2 | 残疾描述 | |
| type_of_challenge_value | PerGlobalInfoCHN | genericString2 | 残疾描述(经过pickList转义) | |
| reference_number | PerGlobalInfoCHN | genericString4 | 是否残疾 | |
| ethnic_group | PerGlobalInfoCHN | genericNumber4 | 民族 | |
| number_of_children | PerGlobalInfoCHN | genericNumber5 | 子女数 | |
| political_status | PerGlobalInfoCHN | customString5 | 政治面貌 | |
| date_of_marriage | PerGlobalInfoCHN | customDate1 | 结婚日期 | |
| userId | EmpEmployment | userId | 用户编码 | |
| probation_period_end_date | EmpEmployment | customDate1 | 试用期结束日期 | |
| social_insurance_payment_date | EmpEmployment | customDate23 | 社保缴纳日期 | |
| original_start_date | EmpEmployment | originalStartDate | 社会工龄起算日 | |
| service_date | EmpEmployment | ServiceDate | 社会工龄起算日 | |
| seniority_start_date | EmpEmployment | seniorityDate | 有效雇佣日期 | |
| probation_start_date | EmpEmployment | startDate | 雇佣日 | |
| legacy_hris_id | EmpEmployment | customString11 | HRM员工编号 | |
| probation_start_date | EmpEmployment | startDate | 入职日期 | |
| probation_period_number | EmpEmployment | customDouble1 | 试用期 | |
| probation_period_frequency | EmpEmployment | customString1 | 试用期单位 | |
| probation_status | EmpEmployment | customString2 | 试用期状态 | |
| entry_into_group | EmpEmployment | customDate2 | 加入集团日期 | |
| job_level_id | EmpJob | customString92 | 人事级别(sf原值) | |
| job_level | EmpJob | customString92 | 人事级别 | |
| job_level_value | EmpJob | customString92 | 人事级别(经过pickList转义) | |
| startdate | EmpJob | startDate | 部门变动日期 | |
| company | EmpJob | company | 公司 | |
| division | EmpJob | division | 本部门 | |
| department | EmpJob | department | 部门，子部门，团队，小组 | |
| contract_start_date | EmpJob | customDate1 | 合同开始日期 | |
| contract_end_date | EmpJob | contractEndDate | 合同结束日期 | |
| contract_type_id | EmpJob | contractType | 无固定期限(sf原值) | |
| contract_type | EmpJob | contractType | 无固定期限 | |
| contract_type_value | EmpJob | contractType | 无固定期限(经过pickList转义) | |
| cost_center | EmpJob | costCenter | 成本中心类别 | |
| health_certificate_effective_date | EmpJob | customDate6 | 健康证发证日 | |
| health_certificate_expiration_date | EmpJob | customDate7 | 健康证到期日 | |
| health_certificate | EmpJob | customString121 | 健康证 | |
| attendance_type_id | EmpJob | customString122 | 工时制(sf原值) | |
| attendance_type | EmpJob | customString122 | 工时制 | |
| attendance_type_value | EmpJob | customString122 | 工时制(经过pickList转义) | |
| job_family_id | EmpJob | customString15 | 职群(sf原值) | |
| job_family | EmpJob | customString15 | 职群 | |
| job_family_value | EmpJob | customString15 | 职群(经过pickList转义) | |
| brand | EmpJob | customString59 | 品牌 | |
| employee_class_id | EmpJob | employeeClass | 员工类别(sf原值) | |
| employee_class | EmpJob | employeeClass | 员工类别 | |
| employee_class_value | EmpJob | employeeClass | 员工类别(经过pickList转义) | |
| event_reason | EmpJob | eventReason | RNS | |
| job_classification | EmpJob | jobCode | 职务等级，担当职务 | |
| location | EmpJob | location | 所属地区 | |
| subsidy_criteria_id | EmpJob | customString128 | 岗位资格(sf原值) | |
| subsidy_criteria | EmpJob | customString128 | 岗位资格 | |
| subsidy_criteria_value | EmpJob | customString128 | 岗位资格(经过pickList转义) | |
| position | EmpJob | position | 职位代码 | |
| position_entry_date | EmpJob | positionEntryDate | 职位开始日 | |
| manager | EmpJob | managerId | 直线主管 | |
| event | EmpJob | event | 事件 | |
| job_function | EmpJob | customString16 | 职位职能 | |
| grade_shk | EmpJob | payGrade | 香港职级 | |
| employee_type | EmpJob | employeeType | 员工类型 | |
| local_job_title | EmpJob | localJobTitle | 本地职位名称 | |
| public_job_title_eng | EmpJob | jobTitle | 英语职位名称 | |
| mode_of_employment_id | EmpJob | customString160 | 控制C0101的就业视野模式(sf原值) | |
| mode_of_employment | EmpJob | customString160 | 控制C0101的就业视野模式 | |
| mode_of_employment_value | EmpJob | customString160 | 控制C0101的就业视野模式(经过pickList转义) | |
| branch_office | EmpJob | customString2 | 默认分支代码 | |
| positionNav_externalName_defaultValue | EmpJob | positionNav_externalName | 职务描述 c_title | |
| employment_status_id | EmpJob | emplStatus | 在职状态(sf原值) | |
| employment_status_code | EmpJob | emplStatus | 在职状态 | |
| employment_status_value | EmpJob | emplStatus | 在职状态(经过pickList转义) | |
| empjob_last_modified_date_time | EmpJob | lastModifiedDateTime | EmpJob最后更新时间 | |
| compensation_startDate | EmpCompensation | startDate | 薪资体系生效开始日期 | |
| pay_group | EmpCompensation | payGroup | 薪资体系 | |
| pay_component | EmpPayCompRecurring | payComponent | 工资构成/付薪类型 | |
| currency | EmpPayCompRecurring | currencyCode | 货币 | |
| frequency | EmpPayCompRecurring | frequency | 频率 | |
| amount | EmpPayCompRecurring | paycompvalue | 金额 | |
| recurring_startDate | EmpPayCompRecurring | startDate | 生效开始日期 | |
| termination_Date | EmpEmploymentTermination | endDate | 离职日期 | |
| termination_reason | EmpEmploymentTermination | eventReason | 离职原因 | |
| last_date_worked | EmpEmploymentTermination | lastDateWorked | 最后工作日期 | |
| empemploymenttermination_last_modified_date_time | EmpEmploymentTermination | lastModifiedDateTime | EmpEmploymentTermination最后更新时间 |
Response body example
[
{
"person_id": "10030227",
"last_modified_date_time": "2022-03-21T13:36:10",
"perperson_last_modified_date_time": "2021-05-05T11:49:44",
"preferred_last_name": "SHEN",
"formal_full_name": "Yu SHEN",
"first_name": "Yu",
"gender": "F",
"gender_value": "女",
"last_name": "SHEN",
"marital_status_id": "1892",
"marital_status": "M",
"marital_status_value": "已婚",
"nationality": "CHN",
"preferred_first_name": "Yu",
"last_name_alt1": "沈",
"first_name_alt1": "矞",
"last_name_alt2": "SHEN",
"first_name_alt2": "Yu",
"last_name_cn": "沈",
"first_name_cn": "矞",
"formalName": "Yu SHEN",
"perpersonal_last_modified_date_time": "2021-05-05T19:03:46",
"national_id": "320626197405293028",
"national_id_card_type": "ResidentIdCard",
"national_id_region": "CHN",
"national_id_is_primary": 1,
"national_id_expiration_date": null,
"national_id_issue_date": null,
"national_id_issuing_authority": null,
"Effective_start_date": null,
"account_number": "1001082901211162316",
"account_owner": "沈矞",
"bank": "CN_ICBC",
"province_of_hukou_id": null,
"province_of_hukou": null,
"province_of_hukou_value": null,
"city_of_hukou_id": null,
"city_of_hukou": null,
"city_of_hukou_value": null,
"place_of_hukou": null,
"level_of_challenge": null,
"hukou_type_id": null,
"hukou_type": null,
"hukou_type_value": null,
"type_of_challenge_id": null,
"type_of_challenge": null,
"type_of_challenge_value": null,
"reference_number": null,
"ethnic_group": null,
"number_of_children": null,
"political_status": null,
"date_of_marriage": null,
"userId": "10030227",
"probation_period_end_date": null,
"social_insurance_payment_date": null,
"original_start_date": null,
"service_date": null,
"seniority_start_date": "2001-10-26T00:00:00",
"probation_start_date": "2001-10-26T00:00:00",
"legacy_hris_id": "00000214",
"probation_period_number": null,
"probation_period_frequency": null,
"probation_status": null,
"entry_into_group": "2001-10-26T00:00:00",
"job_level_id": "7633",
"job_level": "NM",
"job_level_value": "非经理",
"startdate": "2022-03-12T00:00:00",
"company": "C0100",
"division": "60020103",
"department": "60020823",
"contract_start_date": "2013-10-26T00:00:00",
"contract_end_date": "9999-12-31T00:00:00",
"contract_type_id": "290234",
"contract_type": "CHN-NF",
"contract_type_value": "无固定期限",
"cost_center": "A11YI1TZZZ",
"health_certificate_effective_date": null,
"health_certificate_expiration_Date": null,
"health_certificate": null,
"attendance_type_id": null,
"attendance_type": "289649",
"attendance_type_value": null,
"job_family_id": null,
"job_family": "60000006",
"job_family_value": null,
"brand": "CS",
"employee_class_id": "1256",
"employee_class": "P",
"employee_class_value": "正式员工(无固定期限)",
"event_reason": "TERMEND",
"job_classification": "NONE",
"location": "上海",
"subsidy_criteria_id": null,
"subsidy_criteria": null,
"subsidy_criteria_value": null,
"position": "50210220",
"position_entry_date": "2021-01-01T00:00:00",
"manager": "10030210",
"event": "1934",
"job_function": "60000104",
"grade_shk": null,
"employee_type": "7749",
"local_job_title": "培训担当",
"public_job_title_eng": "Training Specialist",
"mode_of_employment_id": null,
"mode_of_employment": null,
"mode_of_employment_value": null,
"branch_office": null,
"positionNav_externalName_defaultValue": "Training Specialist",
"employment_status_id": "1902",
"employment_status_code": "T",
"employment_status_value": "已离职",
"empjob_last_modified_date_time": "2022-03-02T08:31:32",
"compensation_startDate": "2022-03-01T00:00:00",
"pay_group": "CHN_SCH_1",
"pay_component": "60000114",
"currency": "CNY",
"frequency": "60000010",
"amount": 10150.0,
"recurring_startDate": "2022-03-01T00:00:00",
"termination_Date": "2022-03-11T00:00:00",
"last_date_worked": "2022-03-11T00:00:00",
"termination_sub_reason": null,
"empemploymenttermination_last_modified_date_time": "2022-03-02T08:31:30",
"email": [
{
"email_type": "B",
"email_type_value": "公司",
"email_address": "shenyu@shiseido.cn",
"personIdExternal": "10030227",
"is_primary": 1,
"last_modified_date_time": "2021-05-05T19:06:55"
}
],
"phone": [
{
"phone_type": "B",
"phone_type_value": "公司",
"extension": null,
"phone_number": "021-xxxxxx",
"country_code": "5239",
"region_code": "44",
"personIdExternal": "10030227",
"last_modified_date_time": "2021-12-24T11:45:14"
},
{
"phone_type": "P",
"phone_type_value": "个人手机",
"extension": null,
"phone_number": "xxxxxx",
"country_code": "5239",
"region_code": "44",
"personIdExternal": "10030227",
"last_modified_date_time": "2021-05-05T19:06:45"
}
],
"address": [],
"contacts": []
}
]All values ending in _value are the actual mapped values for the picklist that correspond to values without _value.
The following is the mapping between employee status dictionaries.
| externalCode | optionId | label_zh_CN | label_defaultValue |
|---|---|---|---|
| A | 1910 | 在职 | Active |
| D | 1909 | 非活动 | Dormant |
| F | 1906 | 暂时解雇 | Furlough |
| O | 1905 | 已取消 | Cancelled |
| P | 1908 | 带薪假 | Paid Leave |
| R | 1907 | 已退休 | Retired |
| S | 1903 | 已暂停 | Suspended |
| T | 1902 | 已离职 | Inactive |
| U | 1904 | 无薪休假 | Unpaid Leave |
| RNS | 273564 | 已报告不出现 | Reported No Show |